Dashboard Properties

General

Name

The name of the dashboard.

Description

A quick description of the dashboard.

Page Caption

This is used to give a name to the dashboard when it is displayed.  The name will be displayed at the top left of the dashboard.   If the Page Caption is left blank, then it will default to the name given to the dashboard.

Dashboard Group

The Dashboard group to which it belongs.

Behavior

Dashboard Type

This indicates how each dashboard within a group is used. It helps reduce the number of groups needed and simplifies dashboard maintenance.

  • (Use Default): Default is Top Level.

  • Top Level: This dashboard type indicates which dashboards in a group should be visible if assigned to OnePlace or a Workflow.

  • Top Level Without Parameter Prompts: This dashboard type has the same behavior as Top Level, but if the dashboard has runtime parameters, it will have a slight performance improvement. It does not prompt for parameters.

  • Embedded: This dashboard type indicates which dashboards in a group should not be visible in OnePlace because they are dependent on other dashboard objects.

  • Embedded Dynamic: This dashboard type enables you to dynamically modify dashboard properties, component properties, parameters, adapters, and cube view properties. See Dynamic Dashboards.

  • Embedded Dynamic Repeater: This dashboard type enables you to dynamically modify dashboard properties, component properties, parameters, adapters, and cube view properties. This dashboard type can be used to add multiple instances of the same component without having to re-create each component individually. See Embedded Dynamic Repeater Dashboard.

  • Embedded Top Level: This dashboard type acts as a new top level with its own parameter resolution and rendering stages. As a result, it allows for the Load Dashboard Server Task to be run even when embedded.

    NOTE: Currently, Embedded Top Level dashboards should not be used with Smart Links.

  • Embedded Top Level Without Parameter Prompts: This dashboard type acts as a new top level with its own parameter resolution and rendering stages. As a result, it allows for the Load Dashboard Server Task to be run even when embedded. It does not prompt for parameters, resulting in a slight performance improvement.

    NOTE: Currently, Embedded Top Level Without Parameter Prompts dashboards should not be used with Smart Links.

  • Custom Control: This dashboard type has the same behavior as Embedded, but each instance maintains its own set of input parameters, variables, and Event Listeners (actions).

Custom Control

A new dashboard type with required input parameters, which is a comma separated list of parameter names that must be provided by the containing dashboard when processing a custom control dashboard. For example, Param 1, Param 2, Param 3. A parameter component inside the custom control forwards events to the parent dashboard.

Formatting

Layout Type

Canvas (Windows App Only)

A component docks to the top, bottom, right, or left of the dashboard.  The component only shows in the space defined by the dock position and does not display fully on a screen.  Slide bars are used to view the components. When you add a component to a dashboard with this layout type, select a dock position and specify the component's Left, Top, Width, and Height settings.

Dock (Windows App Only)

A component docks to the top, bottom, right, or left of the dashboard.  When adding a component to a dashboard with this layout, use the dock position selection to determine how much of the screen is used and specify either Width or Height settings.

  • Dock positions Left and Right are used in combination with Width.

  • Dock positions Top and Bottom are used in combination with Height.

Grid

This enables you to make a dashboard in a grid format by using rows and columns to add components, lines, or moveable splitters. This selection displays the Grid Layout Type properties. The Position On Dashboard properties are ignored for components added to a dashboard with this layout type.

Horizontal Stack Panel

Each component will display horizontally with one row and at least one column.  Horizontal Stack Panel dashboards are generally used as part of other dashboards. Position On Dashboard properties are ignored for components added to a dashboard with this layout type.

Tabs

Each component will display in its own tab. Position On Dashboard properties are ignored for components added to a dashboard with this layout type.

Uniform

Each component is docked, but all are equal in size. Position On Dashboard properties are ignored for components added to a dashboard with this layout type.

NOTE: If the Toggle Component Size button is used, the dashboard is rendered using Uniform Layout Type.

Vertical Stack Panel

Each component will display vertically with one column and at least one row.  Vertical Stack Panel dashboards are generally used as part of other dashboards. Position On Dashboard properties are ignored for components added to a dashboard with this layout type.

Wrap (Windows App Only)

The layout container wraps each component according to its specified size. When adding a component to a dashboard with this layout, select a dock position and specify either Width or Height settings.

Is initially Visible If Embedded

When set to True, the selected dashboard will be hidden if it is retrieved from another dashboard. To set the hidden dashboard as visible from a component, go to Component Properties >Action > User Interface Action > Selection Changed User Interface Action and select Refresh. In the Dashboards To Show field, list the dashboard containing the embedded dashboard.

Display Format

This allows unique display formatting per dashboard for background color, dialog width and height, and border formatting.  See Display Format Settings.

Show Title

The default value for this property is True. When this property is True, the dashboard title displays in the Modern Browser Experience. This property does not apply to the Windows Application.

Scroll Position

This property enables you to configure the position of the scroll bar upon refresh for Horizontal Stack Panel and Vertical Stack Panel dashboard layout types. This property is disabled for other dashboard layout types. You can choose from the following options:

  • Default (Beginning): When the dashboard is refreshed, the scroll bar is positioned at the beginning of the dashboard. The property defaults to this value.

  • End: When the dashboard is refreshed, the scroll bar is positioned at the end of the dashboard.

  • Save Current Position: When the dashboard is refreshed, the scroll bar maintains its current position on the dashboard.

Literal Parameter Values

Name Value Pairs (e.g., Param1=Value1,…)

Enter a comma-separated list of name-value pairs for this dashboard’s static parameter values.  Piped variable names cannot be used in this setting.

Action (Primary Dashboard Only)

Load Dashboard Server Task

Dashboard Extender Rules can run upon launching and refreshing dashboards.  This only applies to the main dashboard, not embedded dashboards.

No Task

A Dashboard Extender business rule is not being used on this dashboard.

Execute Dashboard Extender Business Rule (Once)

This runs the assigned Business Rule once upon refresh or initial launch

Execute Dashboard Extender Business Rule (All Actions)

This does an iterative action and runs the business rule as many times as needed.

Load Dashboard Server Task Arguments

Enter the arguments required by the server task.  When executing a Dashboard Extender business rule, the arguments include {BusinessRuleName}{FunctionName}{Optional Named-Value Pairs} each enclosed in curly brackets.  Click the ellipsis and select the desired argument format and then enter each object.

Example: {DashboardLoadBRName}{TestFunction}{Param1=[Value1], Param2=[Value2]}

Grid Layout Type

This only becomes available if Grid is chosen as the Layout Type.

Number of Rows

The number of rows the dashboard will use for the grid layout.

Number of Columns

The number of columns the dashboard will use for the grid layout.

Row/Column Type

Component

Use the Component option if a Content or Parameter component is needed for the row or column of the grid layout for the dashboard.

Line

Use the Line option if a line is needed for the row or column on the dashboard.

Moveable Splitter

Use the Moveable Splitter option if one is needed for the row or column on the dashboard.  This allows the ability to move the grid up and down, or left and right.

Row/Column Height

Utilize Row/Column Height to customize the sizing of the rows and columns heights and widths to be displayed on the dashboard. Auto expands the size based on the contents of the row. You can use an * to create a fractional value of the remaining space. For example, if there are three rows, then each row will take a third of the space.